Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introducing mkdocs generated github pages for etcd-druid documentation #909

Merged
merged 20 commits into from
Nov 11, 2024

Conversation

unmarshall
Copy link
Contributor

@unmarshall unmarshall commented Nov 8, 2024

How to categorize this PR?

/area documentation
/kind enhancement

What this PR does / why we need it:
Following is done in this PR:

  1. Small corrections to docs
  2. Introduced mkdocs specific configuration (YAML and CSS)
  3. Added github action to publish the docs
  4. Adapted docs to use mkdocs plugins

Which issue(s) this PR fixes:
Partially fixes #897

Special notes for your reviewer:
Once this PR is reviewed and merged there are some additional steps that needs to be done:

  • Create an orphan and empty gh-pages branch. To create such a branch do the following:
git checkout --orhpan gh-pages
git rm -rf .
git commit --allow-empty -m "<commit-msg>"
git push origin gh-pages
  • Configure github pages to use gh-pages branch

To view the docs you can see this in the fork https://unmarshall.github.io/etcd-druid/index.html

Release note:

Introduced github pages to host the etcd-druid documentation

@unmarshall unmarshall requested a review from a team as a code owner November 8, 2024 13:04
@gardener-robot gardener-robot added needs/review Needs review area/documentation Documentation related kind/enhancement Enhancement, improvement, extension size/xl Size of pull request is huge (see gardener-robot robot/bots/size.py) needs/second-opinion Needs second review by someone else labels Nov 8, 2024
@gardener-robot-ci-3 gardener-robot-ci-3 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Nov 8, 2024
@unmarshall
Copy link
Contributor Author

/test pull-etcd-druid-e2e-kind-nondistroless-etcd

@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 8, 2024
@gardener-robot-ci-3 gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 8, 2024
@unmarshall
Copy link
Contributor Author

/test pull-etcd-druid-e2e-kind-nondistroless-etcd

@gardener-robot-ci-3 gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 8, 2024
@gardener-robot-ci-1 gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 8, 2024
@gardener-robot-ci-2 gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Nov 8, 2024
Copy link
Collaborator

@ashwani2k ashwani2k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me except that now the !!! Note instead of > Note is not the same when rendered in a markdown viewer.
But as our goal is for the people to read through mkdocs, I'm guessing its fine to live with that.

@renormalize renormalize self-assigned this Nov 11, 2024
@gardener-robot-ci-2 gardener-robot-ci-2 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@gardener-robot-ci-3 gardener-robot-ci-3 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@gardener-robot-ci-1 gardener-robot-ci-1 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@gardener-robot-ci-2 gardener-robot-ci-2 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@gardener-robot-ci-2 gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Nov 11, 2024
Copy link
Contributor

@seshachalam-yv seshachalam-yv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@renormalize renormalize left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvements!

Can the same font (if not font, family) be used throughout? The font in the menu bar and title doesn't really look cohesive with the font used for the content.

Screenshot 2024-11-11 at 10 55 43

docs/development/prepare-dev-environment.md Show resolved Hide resolved
.github/workflows/publish-docs.yml Show resolved Hide resolved
docs/usage/recovering-etcd-clusters.md Show resolved Hide resolved
docs/development/raising-a-pr.md Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
@renormalize
Copy link
Member

Please edit the commit message before merging to avoid "WIP" commit messages in the commit history of the repo. Thanks.

@gardener-robot-ci-3 gardener-robot-ci-3 added the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@gardener-robot-ci-1 gardener-robot-ci-1 removed the reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) label Nov 11, 2024
@unmarshall
Copy link
Contributor Author

/retest

@gardener-robot-ci-2 gardener-robot-ci-2 added reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) and removed reviewed/ok-to-test Has approval for testing (check PR in detail before setting this label because PR is run on CI/CD) labels Nov 11, 2024
@unmarshall unmarshall merged commit 62a5829 into gardener:master Nov 11, 2024
11 checks passed
@gardener-robot gardener-robot added the status/closed Issue is closed (either delivered or triaged) label Nov 11, 2024
@renormalize renormalize removed their assignment Nov 11, 2024
@unmarshall unmarshall deleted the mkdocs branch December 12, 2024 08:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation related kind/enhancement Enhancement, improvement, extension needs/ok-to-test Needs approval for testing (check PR in detail before setting this label because PR is run on CI/CD) needs/review Needs review needs/second-opinion Needs second review by someone else size/xl Size of pull request is huge (see gardener-robot robot/bots/size.py) status/closed Issue is closed (either delivered or triaged)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation improvement - Part 2
8 participants